Skip to content

WIP: Subproject ngff-spec under specfications directory #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
jo-mueller wants to merge 26 commits into
base: main
Choose a base branch
from
Draft

WIP: Subproject ngff-spec under specfications directory #404

jo-mueller wants to merge 26 commits into from

Conversation

@jo-mueller
Copy link
Contributor

@jo-mueller jo-mueller commented Jan 7, 2026 •
edited
Loading

Fixes #399

This is a proposed solution on how a joint layout of the ngff page and the future home of the spec, ome/ngff-spec could look like.

Key changes:

  • Deprecated bikeshed: The specs of .5 and 0.6.dev2 were converted into markdown and are added as submodules under the specifications folder here in ngff
  • Moved submodules: As mentioned before, I removed the current submodule structure with the versions on the repo root and the spec versions living on different branches of this repo. Instead, the submodules point to different branches of the ngff-spec repo
  • Consistent build: Since the spec is now written in markdown, the respective md-pages can simply be added to a sphinx toctree directive over here on the ngff page - and as such be part of a uniform page layout.

What I'll try to get working, is that the additional contents of the ngff-spec pages as RTD builds them right now are not yet part of the joint web layout this PR brings. In particular, this includes:

  • rendered schemas
  • rendered examples
  • changelog, version history, which are separate md pages over at ngff-spec

Still, I figure this is a good starting point to improve the overall appearance of the ngff page, make it easier to access and contribute to the spec and address a bunch of issues (see #399)

@jo-mueller
Subproject ngff-spec under specfications directory
a39f1fe 
- update build tools to handle ngff-spec contents
- Make sure schemas are provided as html artefacts
- deprecate bikeshed
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026 •
edited
Loading

Automated Review URLs

@lubianat
Copy link
Contributor

lubianat commented Jan 7, 2026

should we move with

preview on your link looks good, though

@jo-mueller
Copy link
Contributor Author

jo-mueller commented Jan 8, 2026

@lubianat #408 makes total sense to go in first. On second and third thought, I think I may also undo the RTD deprecation in here. My original reason for doing this in the first place was the lack of customization options on how to integrate ngff-spec pages in the ngff page.

But since the placing of the spec submodules under the /specifications directory and the direct inclusion into the ngff page's toctree kind of solve that, maybe that's not an urgent need.

@jo-mueller jo-mueller mentioned this pull request Jan 8, 2026
Merged
@lubianat lubianat mentioned this pull request Jan 12, 2026
Open
@lubianat
Copy link
Contributor

lubianat commented Jan 19, 2026

I know this is WIP, but I don't really see 0.1, 0.2 etc there. Am I doing something wrong?

image

@jo-mueller
Copy link
Contributor Author

jo-mueller commented Jan 19, 2026

@lubianat not at all :) We only merged the backport for 0.1...0.4 last week and I haven't updated the submodule configuration here yet. Will do asap!

@jo-mueller
Copy link
Contributor Author

jo-mueller commented Jan 19, 2026

Oh wait, they're already added, then something else is wrong 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ngff repo structural changes

2 participants

@jo-mueller @lubianat